<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>CyclicRedundancyServiceImpl xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/com/seventytwomiles/architecturerules/services/CyclicRedundancyServiceImpl.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * Copyright 2007 the original author or authors.</em>
<a name="3" href="#3">3</a>   <em> *</em>
<a name="4" href="#4">4</a>   <em> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> *         <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em> *</em>
<a name="10" href="#10">10</a>  <em> * For more information visit</em>
<a name="11" href="#11">11</a>  <em> *         <a href="http://72miles.com" target="alexandria_uri">http://72miles.com</a> and</em>
<a name="12" href="#12">12</a>  <em> *         <a href="http://architecturerules.googlecode.com/svn/docs/index.html" target="alexandria_uri">http://architecturerules.googlecode.com/svn/docs/index.html</a></em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> com.seventytwomiles.architecturerules.services;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong>import</strong> com.seventytwomiles.architecturerules.configuration.Configuration;
<a name="19" href="#19">19</a>  <strong>import</strong> com.seventytwomiles.architecturerules.exceptions.CyclicRedundancyException;
<a name="20" href="#20">20</a>  <strong>import</strong> com.seventytwomiles.architecturerules.exceptions.NoPackagesFoundException;
<a name="21" href="#21">21</a>  <strong>import</strong> com.seventytwomiles.architecturerules.exceptions.SourceNotFoundException;
<a name="22" href="#22">22</a>  <strong>import</strong> javassist.ClassPool;
<a name="23" href="#23">23</a>  <strong>import</strong> javassist.NotFoundException;
<a name="24" href="#24">24</a>  <strong>import</strong> jdepend.framework.JavaClass;
<a name="25" href="#25">25</a>  <strong>import</strong> jdepend.framework.JavaPackage;
<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.*;
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <em>/**<em>*</em></em>
<a name="34" href="#34">34</a>  <em> * &lt;p>Checks for cyclic redundancy among application packages in the source</em>
<a name="35" href="#35">35</a>  <em> * folders.&lt;/p></em>
<a name="36" href="#36">36</a>  <em> *</em>
<a name="37" href="#37">37</a>  <em> * @author mikenereson</em>
<a name="38" href="#38">38</a>  <em> * @see AbstractArchitecturalRules</em>
<a name="39" href="#39">39</a>  <em> */</em>
<a name="40" href="#40">40</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../com/seventytwomiles/architecturerules/services/CyclicRedundancyServiceImpl.html">CyclicRedundancyServiceImpl</a> <strong>extends</strong> <a href="../../../../com/seventytwomiles/architecturerules/services/AbstractArchitecturalRules.html">AbstractArchitecturalRules</a>
<a name="41" href="#41">41</a>          implements <a href="../../../../com/seventytwomiles/architecturerules/services/CyclicRedundancyService.html">CyclicRedundancyService</a> {
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <em>/**<em>*</em></em>
<a name="45" href="#45">45</a>  <em>     * &lt;p>Log to log with&lt;/p></em>
<a name="46" href="#46">46</a>  <em>     *</em>
<a name="47" href="#47">47</a>  <em>     * @parameter log Log</em>
<a name="48" href="#48">48</a>  <em>     */</em>
<a name="49" href="#49">49</a>      <strong>protected</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(
<a name="50" href="#50">50</a>              CyclicRedundancyServiceImpl.<strong>class</strong>);
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <em>/**<em>*</em></em>
<a name="54" href="#54">54</a>  <em>     * &lt;p>Constructor instantiates a new &lt;code>CyclicRedundancyService&lt;/code>&lt;/p></em>
<a name="55" href="#55">55</a>  <em>     *</em>
<a name="56" href="#56">56</a>  <em>     * @param configuration Configuration which contains the source directories</em>
<a name="57" href="#57">57</a>  <em>     * to inspect</em>
<a name="58" href="#58">58</a>  <em>     * @throws SourceNotFoundException when an required source directory does</em>
<a name="59" href="#59">59</a>  <em>     * not exist and when &lt;tt>exception&lt;/tt>=&lt;tt>"true"&lt;/tt> in the source</em>
<a name="60" href="#60">60</a>  <em>     * configuration</em>
<a name="61" href="#61">61</a>  <em>     * @throws NoPackagesFoundException when none of the source directories</em>
<a name="62" href="#62">62</a>  <em>     * exist and &lt;tt>no-packages&lt;/tt>="&lt;tt>ignore&lt;/tt>" in the sources</em>
<a name="63" href="#63">63</a>  <em>     * configuration</em>
<a name="64" href="#64">64</a>  <em>     */</em>
<a name="65" href="#65">65</a>      <strong>public</strong> <a href="../../../../com/seventytwomiles/architecturerules/services/CyclicRedundancyServiceImpl.html">CyclicRedundancyServiceImpl</a>(<strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/configuration/Configuration.html">Configuration</a> configuration) {
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>          <strong>super</strong>(configuration);
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>          log.info(<span class="string">"instantiating new CyclicRedundancyService"</span>);
<a name="70" href="#70">70</a>      }
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>      <em>/**<em>*</em></em>
<a name="74" href="#74">74</a>  <em>     * &lt;p>Check all the packages in all of the source directories and search for</em>
<a name="75" href="#75">75</a>  <em>     * any cyclic redundancy&lt;/p></em>
<a name="76" href="#76">76</a>  <em>     */</em>
<a name="77" href="#77">77</a>      <strong>public</strong> <strong>void</strong> performCyclicRedundancyCheck() {
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>          log.info(<span class="string">"cyclic redundancy check requested"</span>);
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>          <strong>final</strong> Collection&lt;JavaPackage> packages = getPackages();
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>          <em>/**<em>*</em></em>
<a name="84" href="#84">84</a>  <em>         *  TODO: report classes involved</em>
<a name="85" href="#85">85</a>  <em>         *  Report on which class is causing the cyclic redundancy.</em>
<a name="86" href="#86">86</a>  <em>         *  The information is all available from within the JavaPackage</em>
<a name="87" href="#87">87</a>  <em>         *  class.</em>
<a name="88" href="#88">88</a>  <em>         */</em>
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>          <em>/**<em>*</em></em>
<a name="91" href="#91">91</a>  <em>         * Holds any cycles that are found. The structure of this Map is</em>
<a name="92" href="#92">92</a>  <em>         * &lt;JavaPackage, Set> where the first String is the name of the package,</em>
<a name="93" href="#93">93</a>  <em>         * and the Set contains JavaPackge of packages that are in a cycle with</em>
<a name="94" href="#94">94</a>  <em>         * the named package.</em>
<a name="95" href="#95">95</a>  <em>         */</em>
<a name="96" href="#96">96</a>          <strong>final</strong> Map&lt;JavaPackage, Set&lt;JavaPackage>> cycles
<a name="97" href="#97">97</a>                  = <strong>new</strong> HashMap&lt;JavaPackage, Set&lt;JavaPackage>>();
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>          <strong>for</strong> (<strong>final</strong> JavaPackage javaPackage : packages) {
<a name="100" href="#100">100</a> 
<a name="101" href="#101">101</a>             <strong>final</strong> Collection&lt;JavaPackage> afferents
<a name="102" href="#102">102</a>                     = javaPackage.getAfferents();
<a name="103" href="#103">103</a>             <strong>final</strong> Collection&lt;JavaPackage> efferents
<a name="104" href="#104">104</a>                     = javaPackage.getEfferents();
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>             <em>/**<em>*</em></em>
<a name="107" href="#107">107</a> <em>             * afferents Collection is no longer a reference to the afferents,</em>
<a name="108" href="#108">108</a> <em>             * but now a Collection of packages involved in a cyclic dependency</em>
<a name="109" href="#109">109</a> <em>             * with the javaPackage. By calling retainAll the afferents</em>
<a name="110" href="#110">110</a> <em>             * Collection now contains only those javaPackages that were in both</em>
<a name="111" href="#111">111</a> <em>             * the efferents and afferents Collections. And by definition, when</em>
<a name="112" href="#112">112</a> <em>             * a package is both uses the given package, and used by the given</em>
<a name="113" href="#113">113</a> <em>             * package, a cyclic dependency exists.</em>
<a name="114" href="#114">114</a> <em>             */</em>
<a name="115" href="#115">115</a>             afferents.retainAll(efferents);
<a name="116" href="#116">116</a> 
<a name="117" href="#117">117</a>             <strong>final</strong> <strong>boolean</strong> cyclesFound = afferents.size() > 0;
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>             <strong>if</strong> (cyclesFound)
<a name="120" href="#120">120</a>                 addCycle(cycles, javaPackage, afferents);
<a name="121" href="#121">121</a>         }
<a name="122" href="#122">122</a> 
<a name="123" href="#123">123</a>         <strong>if</strong> (cycles.isEmpty()) {
<a name="124" href="#124">124</a> 
<a name="125" href="#125">125</a>             log.info(<span class="string">"found no cyclic redundancies"</span>);
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>         } <strong>else</strong> {
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>             log.warn(<span class="string">"found "</span> + cycles.size() + <span class="string">" cyclic redundancies"</span>);
<a name="130" href="#130">130</a> 
<a name="131" href="#131">131</a>             <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/exceptions/CyclicRedundancyException.html">CyclicRedundancyException</a> cyclicRedundancyException
<a name="132" href="#132">132</a>                     = buildCyclicRedundancyException(cycles);
<a name="133" href="#133">133</a> 
<a name="134" href="#134">134</a>             <strong>throw</strong> cyclicRedundancyException;
<a name="135" href="#135">135</a>         }
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>         log.info(<span class="string">"cyclic redundancy test completed"</span>);
<a name="138" href="#138">138</a>     }
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a> 
<a name="141" href="#141">141</a>     <strong>private</strong> <a href="../../../../com/seventytwomiles/architecturerules/exceptions/CyclicRedundancyException.html">CyclicRedundancyException</a> buildCyclicRedundancyException(
<a name="142" href="#142">142</a>             <strong>final</strong> Map&lt;JavaPackage, Set&lt;JavaPackage>> cycles) {
<a name="143" href="#143">143</a> 
<a name="144" href="#144">144</a>         <strong>final</strong> String message = buildCyclicRedundancyMessage(cycles);
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a>         <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/exceptions/CyclicRedundancyException.html">CyclicRedundancyException</a> exception
<a name="147" href="#147">147</a>                 = <strong>new</strong> <a href="../../../../com/seventytwomiles/architecturerules/exceptions/CyclicRedundancyException.html">CyclicRedundancyException</a>(message);
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>         <strong>final</strong> Map&lt;String, Set&lt;String>> cycleStrings = exception.getCycles();
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>         <strong>for</strong> (<strong>final</strong> Map.Entry&lt;JavaPackage, Set&lt;JavaPackage>> cycle : cycles.entrySet()) {
<a name="152" href="#152">152</a> 
<a name="153" href="#153">153</a>             <strong>final</strong> String packageName = cycle.getKey().getName();
<a name="154" href="#154">154</a>             <strong>final</strong> Set&lt;JavaPackage> packageCycles = cycle.getValue();
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>             <strong>final</strong> Set&lt;String> cyclicPackages;
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>             <strong>if</strong> (cycleStrings.containsKey(packageName)) {
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>                 cyclicPackages = cycleStrings.get(packageName);
<a name="161" href="#161">161</a> 
<a name="162" href="#162">162</a>             } <strong>else</strong> {
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>                 cyclicPackages = <strong>new</strong> HashSet&lt;String>();
<a name="165" href="#165">165</a>             }
<a name="166" href="#166">166</a> 
<a name="167" href="#167">167</a>             <strong>for</strong> (<strong>final</strong> JavaPackage packageCycle : packageCycles) {
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>                 <strong>final</strong> String cycleName = packageCycle.getName();
<a name="170" href="#170">170</a>                 cyclicPackages.add(cycleName);
<a name="171" href="#171">171</a>             }
<a name="172" href="#172">172</a> 
<a name="173" href="#173">173</a>             cycleStrings.put(packageName, cyclicPackages);
<a name="174" href="#174">174</a>         }
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>         exception.getCycles().putAll(cycleStrings);
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>         <strong>return</strong> exception;
<a name="179" href="#179">179</a>     }
<a name="180" href="#180">180</a> 
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>     <em>/**<em>*</em></em>
<a name="183" href="#183">183</a> <em>     * &lt;p>Updates a Map, or puts a new record into a Map of a JavaPackage and</em>
<a name="184" href="#184">184</a> <em>     * its cyclic dependency packages.&lt;/p></em>
<a name="185" href="#185">185</a> <em>     *</em>
<a name="186" href="#186">186</a> <em>     * @param cycles Map of cycles already discovered.</em>
<a name="187" href="#187">187</a> <em>     * @param javaPackage JavaPackage involved in a cyclic dependency</em>
<a name="188" href="#188">188</a> <em>     * @param dependencies Collection of JavaPackages involved in a cyclic</em>
<a name="189" href="#189">189</a> <em>     * dependency with the given javaPackage argument.</em>
<a name="190" href="#190">190</a> <em>     */</em>
<a name="191" href="#191">191</a>     <strong>private</strong> <strong>void</strong> addCycle(<strong>final</strong> Map cycles, <strong>final</strong> JavaPackage javaPackage,
<a name="192" href="#192">192</a>                           <strong>final</strong> Collection dependencies) {
<a name="193" href="#193">193</a> 
<a name="194" href="#194">194</a>         <strong>final</strong> <strong>boolean</strong> exists = cycles.containsKey(javaPackage);
<a name="195" href="#195">195</a>         <strong>final</strong> Set cyclicPackages;
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>         <strong>if</strong> (exists) {
<a name="198" href="#198">198</a>             <em>/**<em>*</em></em>
<a name="199" href="#199">199</a> <em>             * Get existing Set, this JavaPackage has already been</em>
<a name="200" href="#200">200</a> <em>             * discovered for being in a cycle</em>
<a name="201" href="#201">201</a> <em>             */</em>
<a name="202" href="#202">202</a>             <strong>final</strong> Object value = cycles.get(javaPackage);
<a name="203" href="#203">203</a>             cyclicPackages = (HashSet) value;
<a name="204" href="#204">204</a> 
<a name="205" href="#205">205</a>         } <strong>else</strong> {
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>             <em>/**<em>*</em></em>
<a name="208" href="#208">208</a> <em>             * Build a new Set</em>
<a name="209" href="#209">209</a> <em>             */</em>
<a name="210" href="#210">210</a>             cyclicPackages = <strong>new</strong> HashSet();
<a name="211" href="#211">211</a>         }
<a name="212" href="#212">212</a> 
<a name="213" href="#213">213</a>         cyclicPackages.addAll(dependencies);
<a name="214" href="#214">214</a>         cycles.put(javaPackage, cyclicPackages);
<a name="215" href="#215">215</a>     }
<a name="216" href="#216">216</a> 
<a name="217" href="#217">217</a> 
<a name="218" href="#218">218</a>     <em>/**<em>*</em></em>
<a name="219" href="#219">219</a> <em>     * &lt;p>Builds a message detailing all of the java packages that are involved</em>
<a name="220" href="#220">220</a> <em>     * in a cyclic dependency and the packages involved with.&lt;/p></em>
<a name="221" href="#221">221</a> <em>     *</em>
<a name="222" href="#222">222</a> <em>     * @param cycles Map of cycles discovered.</em>
<a name="223" href="#223">223</a> <em>     * @return String a complete message detailing all of the cyclic</em>
<a name="224" href="#224">224</a> <em>     *         dependencies found.</em>
<a name="225" href="#225">225</a> <em>     */</em>
<a name="226" href="#226">226</a>     <strong>private</strong> String buildCyclicRedundancyMessage(
<a name="227" href="#227">227</a>             <strong>final</strong> Map&lt;JavaPackage, Set&lt;JavaPackage>> cycles) {
<a name="228" href="#228">228</a> 
<a name="229" href="#229">229</a>         <strong>final</strong> StringBuffer message = <strong>new</strong> StringBuffer();
<a name="230" href="#230">230</a> 
<a name="231" href="#231">231</a>         message.append(cycles.size())
<a name="232" href="#232">232</a>                 .append(<span class="string">" cyclic dependencies found:"</span>)
<a name="233" href="#233">233</a>                 .append(<span class="string">"\r\n"</span>)
<a name="234" href="#234">234</a>                 .append(<span class="string">"\r\n\t"</span>);
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>         <strong>for</strong> (<strong>final</strong> Map.Entry&lt;JavaPackage, Set&lt;JavaPackage>> entry : cycles.entrySet()) {
<a name="237" href="#237">237</a> 
<a name="238" href="#238">238</a>             <strong>final</strong> JavaPackage javaPackage = entry.getKey();
<a name="239" href="#239">239</a>             <strong>final</strong> Set&lt;JavaPackage> cyclicDependencies = entry.getValue();
<a name="240" href="#240">240</a> 
<a name="241" href="#241">241</a>             message.append(<span class="string">"-- "</span>)
<a name="242" href="#242">242</a>                     .append(javaPackage.getName())
<a name="243" href="#243">243</a>                     .append(<span class="string">"\r\n\t"</span>);
<a name="244" href="#244">244</a> 
<a name="245" href="#245">245</a>             message.append(<span class="string">"|  |"</span>)
<a name="246" href="#246">246</a>                     .append(<span class="string">" (depends on one or more of)"</span>)
<a name="247" href="#247">247</a>                     .append(<span class="string">"\r\n\t"</span>);
<a name="248" href="#248">248</a> 
<a name="249" href="#249">249</a>             <strong>for</strong> (Iterator dependencyIterator = cyclicDependencies.iterator();
<a name="250" href="#250">250</a>                  dependencyIterator.hasNext();) {
<a name="251" href="#251">251</a> 
<a name="252" href="#252">252</a>                 <strong>final</strong> JavaPackage dependency
<a name="253" href="#253">253</a>                         = (JavaPackage) dependencyIterator.next();
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a>                 <strong>final</strong> String listOfClasses
<a name="256" href="#256">256</a>                         = buildListOfClasses(javaPackage, dependency);
<a name="257" href="#257">257</a> 
<a name="258" href="#258">258</a>                 message.append(<span class="string">"|  |"</span>);
<a name="259" href="#259">259</a>                 message.append(<span class="string">"\r\n\t"</span>);
<a name="260" href="#260">260</a>                 message.append(<span class="string">"|  |-- "</span>);
<a name="261" href="#261">261</a>                 message.append(dependency.getName());
<a name="262" href="#262">262</a>                 message.append(<span class="string">"\n"</span>).append(listOfClasses);
<a name="263" href="#263">263</a>                 message.append(<span class="string">"\r\n\t"</span>);
<a name="264" href="#264">264</a> 
<a name="265" href="#265">265</a>                 <strong>if</strong> (!dependencyIterator.hasNext())
<a name="266" href="#266">266</a>                     message.append(<span class="string">"|"</span>).append(<span class="string">"\r\n\t"</span>);
<a name="267" href="#267">267</a>             }
<a name="268" href="#268">268</a>         }
<a name="269" href="#269">269</a> 
<a name="270" href="#270">270</a>         <strong>return</strong> message.toString();
<a name="271" href="#271">271</a>     }
<a name="272" href="#272">272</a> 
<a name="273" href="#273">273</a> 
<a name="274" href="#274">274</a>     <em>/**<em>*</em></em>
<a name="275" href="#275">275</a> <em>     * &lt;p>&lt;/p></em>
<a name="276" href="#276">276</a> <em>     *</em>
<a name="277" href="#277">277</a> <em>     * @param javaPackage &lt;code>JavaPackage&lt;/code> package to describe</em>
<a name="278" href="#278">278</a> <em>     * @param dependency &lt;code>JavaPackage&lt;/code> that the javaPackage argument</em>
<a name="279" href="#279">279</a> <em>     * depends on</em>
<a name="280" href="#280">280</a> <em>     * @return String that can be output to the console that describes the given</em>
<a name="281" href="#281">281</a> <em>     *         javaPackages's dependency.</em>
<a name="282" href="#282">282</a> <em>     */</em>
<a name="283" href="#283">283</a>     <strong>private</strong> String buildListOfClasses(<strong>final</strong> JavaPackage javaPackage,
<a name="284" href="#284">284</a>                                       <strong>final</strong> JavaPackage dependency) {
<a name="285" href="#285">285</a> 
<a name="286" href="#286">286</a>         <strong>final</strong> StringBuffer listOfClasses = <strong>new</strong> StringBuffer();
<a name="287" href="#287">287</a>         <strong>final</strong> Collection&lt;JavaClass> classes = dependency.getClasses();
<a name="288" href="#288">288</a> 
<a name="289" href="#289">289</a>         <strong>for</strong> (<strong>final</strong> JavaClass javaClass : classes) {
<a name="290" href="#290">290</a> 
<a name="291" href="#291">291</a>             <strong>final</strong> Collection&lt;JavaPackage> importedPackages
<a name="292" href="#292">292</a>                     = javaClass.getImportedPackages();
<a name="293" href="#293">293</a> 
<a name="294" href="#294">294</a>             <strong>final</strong> Collection&lt;JavaClass> referencedClassNames
<a name="295" href="#295">295</a>                     = buildListOfImports(javaPackage, javaClass);
<a name="296" href="#296">296</a> 
<a name="297" href="#297">297</a>             <strong>if</strong> (importedPackages.contains(javaPackage)) {
<a name="298" href="#298">298</a> 
<a name="299" href="#299">299</a>                 <strong>final</strong> String referencesToPrint;
<a name="300" href="#300">300</a> 
<a name="301" href="#301">301</a>                 <strong>if</strong> (referencedClassNames.isEmpty()) {
<a name="302" href="#302">302</a> 
<a name="303" href="#303">303</a>                     referencesToPrint = <span class="string">"referenced classes not found"</span>;
<a name="304" href="#304">304</a> 
<a name="305" href="#305">305</a>                 } <strong>else</strong> {
<a name="306" href="#306">306</a> 
<a name="307" href="#307">307</a>                     referencesToPrint = referencedClassNames.toString();
<a name="308" href="#308">308</a>                 }
<a name="309" href="#309">309</a> 
<a name="310" href="#310">310</a>                 listOfClasses.append(<span class="string">"\t|\t"</span>)
<a name="311" href="#311">311</a>                         .append(javaClass.getName())
<a name="312" href="#312">312</a>                         .append(<span class="string">": "</span>)
<a name="313" href="#313">313</a>                         .append(referencesToPrint)
<a name="314" href="#314">314</a>                         .append(<span class="string">"\n"</span>);
<a name="315" href="#315">315</a>             }
<a name="316" href="#316">316</a>         }
<a name="317" href="#317">317</a> 
<a name="318" href="#318">318</a>         <strong>return</strong> listOfClasses.toString();
<a name="319" href="#319">319</a>     }
<a name="320" href="#320">320</a> 
<a name="321" href="#321">321</a> 
<a name="322" href="#322">322</a>     <em>/**<em>*</em></em>
<a name="323" href="#323">323</a> <em>     * &lt;p>Builds a List of class names that the given classWithImports argument</em>
<a name="324" href="#324">324</a> <em>     * are involved with cycle with&lt;/p></em>
<a name="325" href="#325">325</a> <em>     *</em>
<a name="326" href="#326">326</a> <em>     * @param packageInCycle JavaPackage involved in cyclic dependency</em>
<a name="327" href="#327">327</a> <em>     * @param classWithImports JavaClass that is involved in the cyclic</em>
<a name="328" href="#328">328</a> <em>     * dependency</em>
<a name="329" href="#329">329</a> <em>     * @return List of class names which this class imports from the package</em>
<a name="330" href="#330">330</a> <em>     *         involved in the cycle</em>
<a name="331" href="#331">331</a> <em>     */</em>
<a name="332" href="#332">332</a>     <strong>private</strong> List buildListOfImports(<strong>final</strong> JavaPackage packageInCycle,
<a name="333" href="#333">333</a>                                     <strong>final</strong> JavaClass classWithImports) {
<a name="334" href="#334">334</a> 
<a name="335" href="#335">335</a>         <strong>final</strong> List&lt;String> referencedClassNames = <strong>new</strong> LinkedList&lt;String>();
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>         <strong>try</strong> {
<a name="338" href="#338">338</a> 
<a name="339" href="#339">339</a>             <strong>final</strong> ClassPool classPool = ClassPool.getDefault();
<a name="340" href="#340">340</a>             <strong>final</strong> String name = classWithImports.getName();
<a name="341" href="#341">341</a>             <strong>final</strong> Collection&lt;String> refClasses
<a name="342" href="#342">342</a>                     = classPool.get(name).getRefClasses();
<a name="343" href="#343">343</a> 
<a name="344" href="#344">344</a>             <strong>for</strong> (<strong>final</strong> String importedClass : refClasses) {
<a name="345" href="#345">345</a> 
<a name="346" href="#346">346</a>                 <strong>final</strong> <strong>boolean</strong> notSelfClass = !name.equals(importedClass);
<a name="347" href="#347">347</a> 
<a name="348" href="#348">348</a>                 <strong>try</strong> {
<a name="349" href="#349">349</a> 
<a name="350" href="#350">350</a>                     <strong>final</strong> String packageName
<a name="351" href="#351">351</a>                             = classPool.get(importedClass).getPackageName();
<a name="352" href="#352">352</a> 
<a name="353" href="#353">353</a>                     <strong>final</strong> <strong>boolean</strong> importFromCycle
<a name="354" href="#354">354</a>                             = packageName.equals(packageInCycle.getName());
<a name="355" href="#355">355</a> 
<a name="356" href="#356">356</a>                     <strong>if</strong> (notSelfClass &amp;&amp; importFromCycle)
<a name="357" href="#357">357</a>                         referencedClassNames.add(importedClass);
<a name="358" href="#358">358</a> 
<a name="359" href="#359">359</a>                 } <strong>catch</strong> (NotFoundException e) {
<a name="360" href="#360">360</a> 
<a name="361" href="#361">361</a>                     log.error(<span class="string">"could not load reference class"</span>, e);
<a name="362" href="#362">362</a>                 }
<a name="363" href="#363">363</a>             }
<a name="364" href="#364">364</a> 
<a name="365" href="#365">365</a>         } <strong>catch</strong> (NotFoundException e) {
<a name="366" href="#366">366</a> 
<a name="367" href="#367">367</a>             log.error(<span class="string">"could not load reference class"</span>, e);
<a name="368" href="#368">368</a>         }
<a name="369" href="#369">369</a> 
<a name="370" href="#370">370</a>         <strong>return</strong> referencedClassNames;
<a name="371" href="#371">371</a>     }
<a name="372" href="#372">372</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

